cy.prompt docs #6270
cy.prompt docs #6270
Conversation
cypress-documentation
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress-documentation
|
| Branch Review |
cy-prompt
|
| Run status |
|
| Run duration | 04m 17s |
| Commit |
|
| Committer | Jennifer Shehane |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
310
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
10.76%
|
|
|---|---|
|
Untested elements
|
2514
|
|
Tested elements
|
3
|
Accessibility
97.22%
|
|
|---|---|
|
Failed rules
|
0 critical
3 serious
4 moderate
0 minor
|
|
Failed elements
|
425
|
There was a problem hiding this comment.
The doc reads really clearly. I had a few minor suggestions that could help with consistency and clarity:
-
Intro paragraph: It currently says “plain English”, but elsewhere we use “natural language.” To stay consistent and inclusive, maybe switch “plain English” to “natural language.”
-
How it works (opening sentence): The section begins with “…that works for both workflows” before the workflows have been introduced. Could be smoother to move that phrasing to the end of the section instead.
-
How it works (step 5): “On future runs” could be misread as a new CI run instead of a retry in the same run. Suggest changing to “on future attempts.”
-
Authentication & usage: The current line (“sign up to start your 2-week free trial”) might imply payment is required afterward. Maybe reframe to: “If you don’t have a Cloud account, create a free account and gain access to a 2-week trial of all paid features.”
-
Usage limits: Will those be documented here? I found myself wondering about them as I read through.
|
@jbeck-007 Updates here: 08148b2 |
Co-authored-by: Mike McCready <[email protected]>
Co-authored-by: Mike McCready <[email protected]>
Co-authored-by: Mike McCready <[email protected]>
* remove experimentalStudio flag (#6283) * docs: adds --posix-exit-codes cli flag for run mode (#6284) * adds --posix-exit-codes cli flag for run mode * add history entry * clarify option/description table for --posix-exit-codes * expand docs on posix exit codes * prettify bash block * fix changelog link * formatting * Add posixExitCodes to module API page * changelog * lint fix --------- Co-authored-by: Jennifer Shehane <[email protected]> Co-authored-by: Jennifer Shehane <[email protected]> * cy.prompt docs (#6270) * docs: begin writing cy.prompt docs * Iterate on wording * lint * Fix links + improve TOC * Fix some css warnings * update dynamic variable examples * lint fix * update areas based on feedback * lint * Add more examples to prompt docs * lint fix * Add Gherkin examples * lint fix * Add another Gherkin example * lint fix * update some styles to make more space in UI * Update yields of prompt * Update language support * Remove trigger from officially supported 'things to do' * lint * Add not.exist assertions not being supported * expand documented assertion types * Updates for placeholders * update docs * add to TOC * fix loop example. * Update docs/api/commands/prompt.mdx Co-authored-by: Mike McCready <[email protected]> * Update docs/api/commands/prompt.mdx Co-authored-by: Mike McCready <[email protected]> * Some wording updates * Update docs/api/commands/prompt.mdx Co-authored-by: Mike McCready <[email protected]> * lint * fix broken links --------- Co-authored-by: Mike McCready <[email protected]> * chore: add 15.4.0 changelog (#6292) * chore: fix headers (#6293) --------- Co-authored-by: Cacie Prins <[email protected]> Co-authored-by: Mike McCready <[email protected]> Co-authored-by: Bill Glesias <[email protected]>
3 participants
Close #6263